<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <title>glGetProgramInfoLog - OpenGL ES 3 Reference Pages</title>
    <link rel="stylesheet" type="text/css" href="opengl-man.css"/>
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/>
    <script type="text/x-mathjax-config">
            MathJax.Hub.Config({
                MathML: {
                    extensions: ["content-mathml.js"]
                },
                tex2jax: {
                    inlineMath: [['$','$'], ['\\(','\\)']]
                }
            });
        </script>
    <script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"/>
  </head>
  <body>
    <header/>
    <div class="refentry" id="glGetProgramInfoLog">
      <div class="titlepage"/>
      <div class="refnamediv">
        <h2>Name</h2>
        <p>glGetProgramInfoLog — Returns the information log for a program object</p>
      </div>
      <div class="refsynopsisdiv">
        <h2>C Specification</h2>
        <div class="funcsynopsis">
          <table style="border: 0; cellspacing: 0; cellpadding: 0;" class="funcprototype-table">
            <tr>
              <td>
                <code class="funcdef">void <strong class="fsfunc">glGetProgramInfoLog</strong>(</code>
              </td>
              <td>GLuint <var class="pdparam">program</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLsizei <var class="pdparam">maxLength</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLsizei *<var class="pdparam">length</var>, </td>
            </tr>
            <tr>
              <td> </td>
              <td>GLchar *<var class="pdparam">infoLog</var><code>)</code>;</td>
            </tr>
          </table>
          <div class="funcprototype-spacer"> </div>
        </div>
      </div>
      <div class="refsect1" id="parameters">
        <h2>Parameters</h2>
        <div class="variablelist">
          <dl class="variablelist">
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>program</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>Specifies the program object whose information
                    log is to be queried.</p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>maxLength</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>Specifies the size of the character buffer for
                    storing the returned information log.</p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>length</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>Returns the length of the string returned in
                    <em class="parameter"><code>infoLog</code></em> (excluding the null
                    terminator).</p>
            </dd>
            <dt>
              <span class="term">
                <em class="parameter">
                  <code>infoLog</code>
                </em>
              </span>
            </dt>
            <dd>
              <p>Specifies an array of characters that is used
                    to return the information log.</p>
            </dd>
          </dl>
        </div>
      </div>
      <div class="refsect1" id="description">
        <h2>Description</h2>
        <p><code class="function">glGetProgramInfoLog</code> returns the
        information log for the specified program object. The
        information log for a program object is modified when the
        program object is linked or validated. The string that is
        returned will be null terminated.</p>
        <p><code class="function">glGetProgramInfoLog</code> returns in
        <em class="parameter"><code>infoLog</code></em> as much of the information log as
        it can, up to a maximum of <em class="parameter"><code>maxLength</code></em>
        characters. The number of characters actually returned,
        excluding the null termination character, is specified by
        <em class="parameter"><code>length</code></em>. If the length of the returned
        string is not required, a value of <code class="constant">NULL</code> can
        be passed in the <em class="parameter"><code>length</code></em> argument. The
        size of the buffer required to store the returned information
        log can be obtained by calling
        <a class="citerefentry" href="glGetProgramiv.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetProgramiv</span></span></a>
        with the value <code class="constant">GL_INFO_LOG_LENGTH</code>. </p>
        <p>The information log for a program object is either an
        empty string, or a string containing information about the last
        link operation, or a string containing information about the
        last validation operation. It may contain diagnostic messages,
        warning messages, and other information. When a program object
        is created, its information log will be a string of length
        0.</p>
      </div>
      <div class="refsect1" id="notes">
        <h2>Notes</h2>
        <p>The information log for a program object is the OpenGL
        implementer's primary mechanism for conveying information about
        linking and validating. Therefore, the information log can be
        helpful to application developers during the development
        process, even when these operations are successful. Application
        developers should not expect different OpenGL implementations to
        produce identical information logs.</p>
      </div>
      <div class="refsect1" id="errors">
        <h2>Errors</h2>
        <p><code class="constant">GL_INVALID_VALUE</code> is generated if
        <em class="parameter"><code>program</code></em> is not a value generated by
        OpenGL.</p>
        <p><code class="constant">GL_INVALID_OPERATION</code> is generated if
        <em class="parameter"><code>program</code></em> is not a program object.</p>
        <p><code class="constant">GL_INVALID_VALUE</code> is generated if
        <em class="parameter"><code>maxLength</code></em> is less than 0.</p>
      </div>
      <div class="refsect1" id="associatedgets">
        <h2>Associated Gets</h2>
        <p><a class="citerefentry" href="glGetProgramiv.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetProgramiv</span></span></a>
        with argument <code class="constant">GL_INFO_LOG_LENGTH</code></p>
        <p>
          <a class="citerefentry" href="glIsProgram.xhtml">
            <span class="citerefentry">
              <span class="refentrytitle">glIsProgram</span>
            </span>
          </a>
        </p>
      </div>
      <div class="refsect1" id="versions">
        <h2>API Version Support</h2>
        <div class="informaltable">
          <table style="border-collapse: collapse; border-top: 2px solid ; border-bottom: 2px solid ; border-left: 2px solid ; border-right: 2px solid ; ">
            <colgroup>
              <col style="text-align: left; "/>
              <col style="text-align: center; " class="firstvers"/>
              <col style="text-align: center; " class="lastvers"/>
            </colgroup>
            <thead>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; ">
                 
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; " colspan="2">
                <span class="bold"><strong>OpenGL ES API Version</strong></span>
            </th>
              </tr>
              <tr>
                <th style="text-align: left; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>Function Name</strong></span>
            </th>
                <th style="text-align: center; border-right: 2px solid ; border-bottom: 2px solid ; ">
                <span class="bold"><strong>2.0</strong></span>
            </th>
                <th style="text-align: center; border-bottom: 2px solid ; ">
                <span class="bold"><strong>3.0</strong></span>
            </th>
              </tr>
            </thead>
            <tbody>
              <tr>
                <td style="text-align: left; border-right: 2px solid ; ">glGetProgramInfoLog</td>
                <td style="text-align: center; border-right: 2px solid ; ">✔</td>
                <td style="text-align: center; ">✔</td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
      <div class="refsect1" id="seealso">
        <h2>See Also</h2>
        <p><a class="citerefentry" href="glCompileShader.xhtml"><span class="citerefentry"><span class="refentrytitle">glCompileShader</span></span></a>,
        <a class="citerefentry" href="glGetShaderInfoLog.xhtml"><span class="citerefentry"><span class="refentrytitle">glGetShaderInfoLog</span></span></a>,
        <a class="citerefentry" href="glLinkProgram.xhtml"><span class="citerefentry"><span class="refentrytitle">glLinkProgram</span></span></a>,
        <a class="citerefentry" href="glValidateProgram.xhtml"><span class="citerefentry"><span class="refentrytitle">glValidateProgram</span></span></a></p>
      </div>
      <div class="refsect1" id="Copyright">
        <h2>Copyright</h2>
        <p>
            Copyright <span class="trademark"/>© 2003-2005 3Dlabs Inc. Ltd.
            Copyright <span class="trademark"/>© 2010-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <a class="link" href="http://opencontent.org/openpub/" target="_top">http://opencontent.org/openpub/</a>.
        </p>
      </div>
    </div>
    <footer/>
  </body>
</html>
